Skip to content

Add documentation for aamtest test type#58632

Merged
spectranaut merged 4 commits intoacacia-wdspec-style-testsfrom
acacia-wdspec-documentation
Apr 27, 2026
Merged

Add documentation for aamtest test type#58632
spectranaut merged 4 commits intoacacia-wdspec-style-testsfrom
acacia-wdspec-documentation

Conversation

@spectranaut
Copy link
Copy Markdown
Contributor

@spectranaut spectranaut commented Mar 20, 2026

Add documentation for test type introduced in: #57696

See the RFC: web-platform-tests/rfcs#204

@spectranaut
Copy link
Copy Markdown
Contributor Author

@cookiecrook do you want to take a look at this?

@spectranaut spectranaut force-pushed the acacia-wdspec-style-tests branch from bade881 to a6d23f7 Compare April 13, 2026 21:14
@spectranaut spectranaut requested review from a team as code owners April 13, 2026 21:14
@spectranaut spectranaut force-pushed the acacia-wdspec-documentation branch from b307ca9 to 59b45e9 Compare April 16, 2026 20:34
@spectranaut spectranaut force-pushed the acacia-wdspec-style-tests branch from 1875b95 to 5af5f5f Compare April 16, 2026 20:42
Copy link
Copy Markdown
Contributor

@cookiecrook cookiecrook left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partially reviewed.

Comment on lines 17 to 25
Copy link
Copy Markdown
Contributor

@cookiecrook cookiecrook Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a mismatch between the commented subrole expectation from the spec (<nil>) and the asserted value (AXUnknown). I haven't looked into whether this is an actual problem, but even if not, it could use a comment explaining the mismatch.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah good catch. I made an issue for that on core-aam! w3c/core-aam#259

Comment on lines 5 to 11
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this either stub out the others (Edge, Safari, etc) or add a comment explaining that future expectation?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a todo on the original PR.

Comment on lines 77 to 78
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this one verify it's the tab with the test URL like you do in atspi_wrapper.py? Or add a TODO in case the lack of that verification step makes it flaky?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added TODO in the original PR.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to add this as a mergable suggestion, but GH is having trouble.

Closing tag is </div> but should be </button>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ooo nice catch ty!

Comment thread docs/test-suite-design.md Outdated

* [aamtest][] tests are written in Python and test accessibility API mappings,
such as [Core Accessibility API Mappings](https://w3c.github.io/core-aam/)
or [HTML Accessibility API Mappings](https://w3c.github.io/core-aam/).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
or [HTML Accessibility API Mappings](https://w3c.github.io/core-aam/).
or [HTML Accessibility API Mappings](https://w3c.github.io/html-aam/).

@spectranaut spectranaut force-pushed the acacia-wdspec-style-tests branch from 3678cc1 to f89b949 Compare April 27, 2026 19:14
@spectranaut spectranaut force-pushed the acacia-wdspec-documentation branch from 59b45e9 to bda939b Compare April 27, 2026 19:16
@spectranaut spectranaut force-pushed the acacia-wdspec-documentation branch from bda939b to 56d7b55 Compare April 27, 2026 21:10
@spectranaut spectranaut merged commit a2d6005 into acacia-wdspec-style-tests Apr 27, 2026
14 of 22 checks passed
@spectranaut spectranaut deleted the acacia-wdspec-documentation branch April 27, 2026 21:32

The aamtest tests are used to verify the mapping of web content to
browser-exposed platform-specific accessibility APIs. These mappings are
specified by the ARIA working group of the W3C in the following specifications:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not just ARIA WG for the extension specs like DPUB and PDF.


## Platform-Specific Accessibility APIs

Accessibility APIs are platform specific, each platform has their own API
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add “or OS” here too, since some people don’t use the terms “platform” and “OS” as interchangeably as you and I do?

* The name of the pytest fixture that returns access to the API (if you are
on the correct platform).
* The platform of that API.
* The python library that provides bindings to query the API.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should Python be capitalized here to match your other proper noun terms?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants